Update Identity Provider

Path Parameters

workspaceName string required

providerAlias string required

Header Parameters

Authentication string

Example: Bearer {{token}}

application/json

Request Body

aliasstring

The app identifier registered with the identity provider.

internalIdstring

The Id of the Identity provider

providerIdstring

Id of the Identity provider

enabledboolean

Enable/disable this identity provider.

updateProfileFirstLoginModestring

It will update the profile details in identity provider when user logged in for the first time.

trustEmailboolean

If enabled, email provided by this provider is not verified even if verification is enabled for the workspace.

storeTokenboolean

true/false if tokens must be stored after authenticating users.

addReadTokenRoleOnCreateboolean

Enable/disable if new users can read any stored tokens. This assigns the broker.read-token role.

authenticateByDefaultboolean

If it's enabled it will authenticate when page loads.

linkOnlyfalse

If true, users cannot log in through this provider. They can only link to this provider. This is useful if you don't want to allow login from the provider, but want to integrate with a provider

firstBrokerLoginFlowAliasstring

Name of the first broker login flow name

configobject

Configuration for the identity provider

Sample Request Body
{
    "alias": "keycloak-oidc-2",
    "internalId": "0df24d90-d39e-4e02-ab3d-7150efa40b1d",
    "providerId": "keycloak-oidc",
    "enabled": true,
    "updateProfileFirstLoginMode": "on",
    "trustEmail": false,
    "storeToken": false,
    "addReadTokenRoleOnCreate": false,
    "authenticateByDefault": false,
    "linkOnly": false,
    "firstBrokerLoginFlowAlias": "first broker login",
    "config": {}
}

Response